/*
   Copyright 2009 Abdulla Abdurakhmanov (abdulla@latestbit.com)
   Original sources are available at www.latestbit.com

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package org.latestbit.smartobjects.network;

import java.util.Collection;

/**
 * Interface describers user credentials and access information. 
 * Maybe used applications in connection based authentication configuration. 
 * @author abdulla-a
 *
 */
public interface IUserCredentials {
	/**
	 * Gets user identifier (login or other key)
	 * @return user identifier
	 */
	String getUserId();
	
	/**
	 * Gets group names where this user is registered 
	 * @return group name list
	 */
	Collection<String> getUserGroups();
	
	/**
	 * Checks availability this user in the specified group
	 * @param groupName group name
	 * @return true, if this user in the specified group, else - false
	 */
	boolean isUserInGroup(String groupName);
}
